Platform Explorer / Nuxeo Platform 2021

Operation PDF.ExtractPages (PDF: Extract Pages)

In component org.nuxeo.ecm.platform.pdf.operations

Description

Extract pages from startPage to endPage (inclusive) from the input object. If a Blob is used as input, the xpath parameter is not used. title, subject and author are optional. If the PDF is encrypted, a password is required.
Operation id PDF.ExtractPages
Category Conversion
Label PDF: Extract Pages
Requires
Since

Parameters

Name Description Type Required Default value
endPage long yes  
startPage long yes  
fileName string no  
password string no  
pdfAuthor string no  
pdfSubject string no  
pdfTitle string no  
xpath string no file:content 

Signature

Inputs blob, document
Outputs blob, blob

Implementation Information

Implementation Class Class: org.nuxeo.ecm.platform.pdf.operations.PDFExtractPagesOperation
Contributing Component org.nuxeo.ecm.platform.pdf.operations

JSON Definition

{
  "id" : "PDF.ExtractPages",
  "label" : "PDF: Extract Pages",
  "category" : "Conversion",
  "requires" : null,
  "description" : "Extract pages from <code>startPage</code> to <code>endPage</code> (inclusive) from the input object. If a Blob is used as input, the <code>xpath</xpath> parameter is not used. <code>title</code>, <code>subject</code> and <code>author</code> are optional. If the PDF is encrypted, a password is required.",
  "url" : "PDF.ExtractPages",
  "signature" : [ "blob", "blob", "document", "blob" ],
  "params" : [ {
    "name" : "endPage",
    "description" : null,
    "type" : "long",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "startPage",
    "description" : null,
    "type" : "long",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "fileName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "password",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pdfAuthor",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pdfSubject",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pdfTitle",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "xpath",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "file:content" ]
  } ]
}